Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update help info and documentation #487

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

update help info and documentation #487

wants to merge 15 commits into from

Conversation

nanjiangshu
Copy link
Contributor

@nanjiangshu nanjiangshu commented Jan 10, 2025 •
edited
Loading

Related issue(s) and PR(s)
This PR closes #478

Changes made

  • The help message follows similar style as Docker
  • The main help message becomes concise and shows the list of commands with a brief description without verbose instructions.
  • Help message of the sub commands are collected in a single string variable to keep a uniformed style, e.g., uniformed indentation.
  • All flags are shown with single dash to remove the ambiguity.
  • Errors and outdated descriptions in the README are corrected.
  • Descriptions related to login are removed in the README and the loginsectionis moved to a new sectionFeatures under development`
  • A README link specific to the version is printed in the main help message.

How to test

@nanjiangshu nanjiangshu force-pushed the refactor/update-help branch 2 times, most recently from def2e7f to a1efe7f Compare January 15, 2025 22:43
@nanjiangshu
make the main help message concise and clean
bf7f242
@nanjiangshu
update help message for createKey
351d65e
@nanjiangshu
update help message for decrypt
62cd195
@nanjiangshu
update gitignore
b148ac7
@nanjiangshu
update help message for download
7ff64ed
@nanjiangshu
update help message for upload
6c6287a
@nanjiangshu
update help message for list
ff80314
@nanjiangshu
update help message for htsget
988a223
@nanjiangshu
update help message for login
edcb5b6
@nanjiangshu
update help message for encrypt
37f842d
@nanjiangshu
remove ArgHelp
d51338c
@nanjiangshu
remove help for login from the main help
2db4765
@nanjiangshu
update readme, fix errors, improve text
468962a 
fix error in the readme regarding download dataset

fix error in download command in readme

update readme part 1

update readme part 2

update readme part 3

update readme part 4

update readme part 5
@nanjiangshu
print version specific link to the README in main help
d0a4c05
@nanjiangshu
only show flags with single dash
f9b173e
@nanjiangshu nanjiangshu marked this pull request as ready for review January 15, 2025 23:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Outdated documentation and the help
1 participant
@nanjiangshu